<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *     http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.commons.jxpath;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import java.io.Serializable;<a name="line.19"></a>
<FONT color="green">020</FONT>    <a name="line.20"></a>
<FONT color="green">021</FONT>    /**<a name="line.21"></a>
<FONT color="green">022</FONT>     * Pointers represent locations of objects and their properties<a name="line.22"></a>
<FONT color="green">023</FONT>     * in Java object graphs. JXPathContext has methods<a name="line.23"></a>
<FONT color="green">024</FONT>     * ({@link JXPathContext#getPointer(java.lang.String) getPointer()}<a name="line.24"></a>
<FONT color="green">025</FONT>     * and  ({@link JXPathContext#iteratePointers(java.lang.String)<a name="line.25"></a>
<FONT color="green">026</FONT>     * iteratePointers()}, which, given an XPath, produce Pointers for the objects<a name="line.26"></a>
<FONT color="green">027</FONT>     * or properties described the the path. For example, &lt;code&gt;ctx.getPointer<a name="line.27"></a>
<FONT color="green">028</FONT>     * ("foo/bar")&lt;/code&gt; will produce a Pointer that can get and set the property<a name="line.28"></a>
<FONT color="green">029</FONT>     * "bar" of the object which is the value of the property "foo" of the root<a name="line.29"></a>
<FONT color="green">030</FONT>     * object. The value of &lt;code&gt;ctx.getPointer("aMap/aKey[3]")&lt;/code&gt; will be a<a name="line.30"></a>
<FONT color="green">031</FONT>     * pointer to the 3'rd element of the array, which is the value for the key<a name="line.31"></a>
<FONT color="green">032</FONT>     * "aKey" of the map, which is the value of the property "aMap" of the root<a name="line.32"></a>
<FONT color="green">033</FONT>     * object.<a name="line.33"></a>
<FONT color="green">034</FONT>     *<a name="line.34"></a>
<FONT color="green">035</FONT>     * @author Dmitri Plotnikov<a name="line.35"></a>
<FONT color="green">036</FONT>     * @version $Revision: 652845 $ $Date: 2008-05-02 12:46:46 -0500 (Fri, 02 May 2008) $<a name="line.36"></a>
<FONT color="green">037</FONT>     */<a name="line.37"></a>
<FONT color="green">038</FONT>    public interface Pointer extends Cloneable, Comparable, Serializable {<a name="line.38"></a>
<FONT color="green">039</FONT>    <a name="line.39"></a>
<FONT color="green">040</FONT>        /**<a name="line.40"></a>
<FONT color="green">041</FONT>         * Returns the value of the object, property or collection element<a name="line.41"></a>
<FONT color="green">042</FONT>         * this pointer represents. May convert the value to one of the<a name="line.42"></a>
<FONT color="green">043</FONT>         * canonical InfoSet types: String, Number, Boolean, Set.<a name="line.43"></a>
<FONT color="green">044</FONT>         *<a name="line.44"></a>
<FONT color="green">045</FONT>         * For example, in the case of an XML element, getValue() will<a name="line.45"></a>
<FONT color="green">046</FONT>         * return the text contained by the element rather than<a name="line.46"></a>
<FONT color="green">047</FONT>         * the element itself.<a name="line.47"></a>
<FONT color="green">048</FONT>         * @return Object value<a name="line.48"></a>
<FONT color="green">049</FONT>         */<a name="line.49"></a>
<FONT color="green">050</FONT>        Object getValue();<a name="line.50"></a>
<FONT color="green">051</FONT>    <a name="line.51"></a>
<FONT color="green">052</FONT>        /**<a name="line.52"></a>
<FONT color="green">053</FONT>         * Returns the raw value of the object, property or collection element<a name="line.53"></a>
<FONT color="green">054</FONT>         * this pointer represents.  Never converts the object to a<a name="line.54"></a>
<FONT color="green">055</FONT>         * canonical type: returns it as is.<a name="line.55"></a>
<FONT color="green">056</FONT>         *<a name="line.56"></a>
<FONT color="green">057</FONT>         * For example, for an XML element, getNode() will<a name="line.57"></a>
<FONT color="green">058</FONT>         * return the element itself rather than the text it contains.<a name="line.58"></a>
<FONT color="green">059</FONT>         * @return Object node<a name="line.59"></a>
<FONT color="green">060</FONT>         */<a name="line.60"></a>
<FONT color="green">061</FONT>        Object getNode();<a name="line.61"></a>
<FONT color="green">062</FONT>    <a name="line.62"></a>
<FONT color="green">063</FONT>        /**<a name="line.63"></a>
<FONT color="green">064</FONT>         * Modifies the value of the object, property or collection element<a name="line.64"></a>
<FONT color="green">065</FONT>         * this pointer represents.<a name="line.65"></a>
<FONT color="green">066</FONT>         * @param value value to set<a name="line.66"></a>
<FONT color="green">067</FONT>         */<a name="line.67"></a>
<FONT color="green">068</FONT>        void setValue(Object value);<a name="line.68"></a>
<FONT color="green">069</FONT>    <a name="line.69"></a>
<FONT color="green">070</FONT>        /**<a name="line.70"></a>
<FONT color="green">071</FONT>         * Returns the node this pointer is based on.<a name="line.71"></a>
<FONT color="green">072</FONT>         * @return Object<a name="line.72"></a>
<FONT color="green">073</FONT>         */<a name="line.73"></a>
<FONT color="green">074</FONT>        Object getRootNode();<a name="line.74"></a>
<FONT color="green">075</FONT>    <a name="line.75"></a>
<FONT color="green">076</FONT>        /**<a name="line.76"></a>
<FONT color="green">077</FONT>         * Returns a string that is a proper "canonical" XPath that corresponds to<a name="line.77"></a>
<FONT color="green">078</FONT>         * this pointer.  Consider this example:<a name="line.78"></a>
<FONT color="green">079</FONT>         * &lt;p&gt;&lt;code&gt;Pointer  ptr = ctx.getPointer("//employees[firstName = 'John']")<a name="line.79"></a>
<FONT color="green">080</FONT>         * &lt;/code&gt;<a name="line.80"></a>
<FONT color="green">081</FONT>         * &lt;p&gt;The  value of &lt;code&gt;ptr.asPath()&lt;/code&gt; will look something like<a name="line.81"></a>
<FONT color="green">082</FONT>         * &lt;code&gt;"/departments[2]/employees[3]"&lt;/code&gt;, so, basically, it represents<a name="line.82"></a>
<FONT color="green">083</FONT>         * the concrete location(s) of the result of a search performed by JXPath.<a name="line.83"></a>
<FONT color="green">084</FONT>         * If an object in the pointer's path is a Dynamic Property object (like a<a name="line.84"></a>
<FONT color="green">085</FONT>         * Map), the asPath method generates an XPath that looks like this: &lt;code&gt;"<a name="line.85"></a>
<FONT color="green">086</FONT>         * /departments[@name = 'HR']/employees[3]"&lt;/code&gt;.<a name="line.86"></a>
<FONT color="green">087</FONT>         * @return String path<a name="line.87"></a>
<FONT color="green">088</FONT>         */<a name="line.88"></a>
<FONT color="green">089</FONT>        String asPath();<a name="line.89"></a>
<FONT color="green">090</FONT>    <a name="line.90"></a>
<FONT color="green">091</FONT>        /**<a name="line.91"></a>
<FONT color="green">092</FONT>         * Pointers are cloneable.<a name="line.92"></a>
<FONT color="green">093</FONT>         * @return cloned Object<a name="line.93"></a>
<FONT color="green">094</FONT>         */<a name="line.94"></a>
<FONT color="green">095</FONT>        Object clone();<a name="line.95"></a>
<FONT color="green">096</FONT>    }<a name="line.96"></a>




























































</PRE>
</BODY>
</HTML>
